<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_30) on Wed Jun 27 10:04:51 EEST 2012 -->
<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
<TITLE>
UIBuilder
</TITLE>

<META NAME="date" CONTENT="2012-06-27">

<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">

<SCRIPT type="text/javascript">
function windowTitle()
{
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="UIBuilder";
    }
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>

</HEAD>

<BODY BGCOLOR="white" onload="windowTitle();">
<HR>


<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/UIBuilder.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../com/sun/lwuit/util/Resources.html" title="class in com.sun.lwuit.util"><B>PREV CLASS</B></A>&nbsp;
&nbsp;NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html?com/sun/lwuit/util/UIBuilder.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="UIBuilder.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->

<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sun.lwuit.util</FONT>
<BR>
Class UIBuilder</H2>
<PRE>
java.lang.Object
  <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.sun.lwuit.util.UIBuilder</B>
</PRE>
<HR>
<DL>
<DT><PRE>public class <B>UIBuilder</B><DT>extends java.lang.Object</DL>
</PRE>

<P>
The UI builder can create a user interface based on the UI designed in the
 resource editor and allows us to bind to said UI. Notice that if a Component
 was used in the GUI that is not a part of the com.sun.lwuit package (even a
 Component from sub packages such as table or tree) it MUST be registered
 before loading a GUI!
<P>

<P>
<HR>

<P>
<!-- =========== FIELD SUMMARY =========== -->

<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#BACK_COMMAND_ID">BACK_COMMAND_ID</A></B></CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#FORM_STATE_KEY_FOCUS">FORM_STATE_KEY_FOCUS</A></B></CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A key in the form state hashtable used in the back command navigation</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#FORM_STATE_KEY_NAME">FORM_STATE_KEY_NAME</A></B></CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A key in the form state hashtable used in the back command navigation</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#FORM_STATE_KEY_SELECTION">FORM_STATE_KEY_SELECTION</A></B></CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A key in the form state hashtable used in the back command navigation</TD>
</TR>
</TABLE>
&nbsp;
<!-- ======== CONSTRUCTOR SUMMARY ======== -->

<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#UIBuilder()">UIBuilder</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->

<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#addCommandListener(com.sun.lwuit.events.ActionListener)">addCommandListener</A></B>(<A HREF="../../../../com/sun/lwuit/events/ActionListener.html" title="interface in com.sun.lwuit.events">ActionListener</A>&nbsp;l)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds a command listener that would be bound to all forms in the GUI seamlessly</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#addCommandListener(java.lang.String, com.sun.lwuit.events.ActionListener)">addCommandListener</A></B>(java.lang.String&nbsp;formName,
                   <A HREF="../../../../com/sun/lwuit/events/ActionListener.html" title="interface in com.sun.lwuit.events">ActionListener</A>&nbsp;l)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds a command listener to be invoked for commands on a specific form</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#addComponentListener(java.lang.String, java.lang.String, java.lang.Object)">addComponentListener</A></B>(java.lang.String&nbsp;formName,
                     java.lang.String&nbsp;componentName,
                     java.lang.Object&nbsp;listener)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds a component listener that would be bound when a UI for this form is created.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#allowBackTo(java.lang.String)">allowBackTo</A></B>(java.lang.String&nbsp;formName)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates whether a back command to this form should be generated automatically when
 leaving said form.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#asyncCommandProcess(com.sun.lwuit.Command, com.sun.lwuit.events.ActionEvent)">asyncCommandProcess</A></B>(<A HREF="../../../../com/sun/lwuit/Command.html" title="class in com.sun.lwuit">Command</A>&nbsp;cmd,
                    <A HREF="../../../../com/sun/lwuit/events/ActionEvent.html" title="class in com.sun.lwuit.events">ActionEvent</A>&nbsp;sourceEvent)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Warning: This method is invoked OFF the EDT and is intended for usage with asynchronous
 command processing.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#back()">back</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method effectively pops the form navigation stack and goes back
 to the previous form if back navigation is enabled and there is
 a previous form.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#back(com.sun.lwuit.Component)">back</A></B>(<A HREF="../../../../com/sun/lwuit/Component.html" title="class in com.sun.lwuit">Component</A>&nbsp;sourceComponent)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method effectively pops the form navigation stack and goes back
 to the previous form if back navigation is enabled and there is
 a previous form.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#beforeShow(com.sun.lwuit.Form)">beforeShow</A></B>(<A HREF="../../../../com/sun/lwuit/Form.html" title="class in com.sun.lwuit">Form</A>&nbsp;f)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method allows binding an action that should occur before showing the given
 form</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#beforeShowContainer(com.sun.lwuit.Container)">beforeShowContainer</A></B>(<A HREF="../../../../com/sun/lwuit/Container.html" title="class in com.sun.lwuit">Container</A>&nbsp;c)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method allows binding an action that should occur before showing the given
 container</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#bindListenerToComponent(com.sun.lwuit.Component, java.lang.Object)">bindListenerToComponent</A></B>(<A HREF="../../../../com/sun/lwuit/Component.html" title="class in com.sun.lwuit">Component</A>&nbsp;cmp,
                        java.lang.Object&nbsp;listener)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Binds the given listener object to the component, this works seamlessly for 
 common LWUIT events but might be an issue with custom components and custom
 listener types so this method can be overloaded to add support for such cases.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;<A HREF="../../../../com/sun/lwuit/Command.html" title="class in com.sun.lwuit">Command</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#createCommand(java.lang.String, com.sun.lwuit.Image, int, java.lang.String)">createCommand</A></B>(java.lang.String&nbsp;commandName,
              <A HREF="../../../../com/sun/lwuit/Image.html" title="class in com.sun.lwuit">Image</A>&nbsp;icon,
              int&nbsp;commandId,
              java.lang.String&nbsp;action)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a command instance.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;<A HREF="../../../../com/sun/lwuit/Component.html" title="class in com.sun.lwuit">Component</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#createComponentInstance(java.lang.String, java.lang.Class)">createComponentInstance</A></B>(java.lang.String&nbsp;componentType,
                        java.lang.Class&nbsp;cls)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method can be overriden to create custom components in a custom way, the component
 type is a shorthand for the component name and not the full name of the class.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../com/sun/lwuit/Container.html" title="class in com.sun.lwuit">Container</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#createContainer(com.sun.lwuit.util.Resources, java.lang.String)">createContainer</A></B>(<A HREF="../../../../com/sun/lwuit/util/Resources.html" title="class in com.sun.lwuit.util">Resources</A>&nbsp;res,
                java.lang.String&nbsp;resourceName)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates the container defined under the given name in the res file</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../com/sun/lwuit/Container.html" title="class in com.sun.lwuit">Container</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#createContainer(java.lang.String, java.lang.String)">createContainer</A></B>(java.lang.String&nbsp;resPath,
                java.lang.String&nbsp;resourceName)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates the container defined under the given name in the res file</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#exitForm(com.sun.lwuit.Form)">exitForm</A></B>(<A HREF="../../../../com/sun/lwuit/Form.html" title="class in com.sun.lwuit">Form</A>&nbsp;f)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method allows binding an action that should occur before leaving the given
 form, e.g. memory cleanup</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;<A HREF="../../../../com/sun/lwuit/util/Resources.html" title="class in com.sun.lwuit.util">Resources</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#fetchResourceFile()">fetchResourceFile</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method may be overriden by subclasses to provide a way to dynamically load
 a resource file.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../com/sun/lwuit/Component.html" title="class in com.sun.lwuit">Component</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#findByName(java.lang.String, com.sun.lwuit.Container)">findByName</A></B>(java.lang.String&nbsp;name,
           <A HREF="../../../../com/sun/lwuit/Container.html" title="class in com.sun.lwuit">Container</A>&nbsp;rootComponent)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Finds the given component by its name</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;java.util.Hashtable</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#getContainerState(com.sun.lwuit.Container)">getContainerState</A></B>(<A HREF="../../../../com/sun/lwuit/Container.html" title="class in com.sun.lwuit">Container</A>&nbsp;cnt)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method is the container navigation equivalent of getFormState() see
 that method for details.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;java.util.Hashtable</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#getFormState(com.sun.lwuit.Form)">getFormState</A></B>(<A HREF="../../../../com/sun/lwuit/Form.html" title="class in com.sun.lwuit">Form</A>&nbsp;f)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the state of the current form which we are about to leave as part
 of the navigation logic.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#getHomeForm()">getHomeForm</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;When reaching the home form the navigation stack is cleared</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#getResourceFilePath()">getResourceFilePath</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Allows the navigation code to avoid storing the resource file and lets the GC
 remove it from memory when its not in use</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;<A HREF="../../../../com/sun/lwuit/Container.html" title="class in com.sun.lwuit">Container</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#getRootAncestor(com.sun.lwuit.Component)">getRootAncestor</A></B>(<A HREF="../../../../com/sun/lwuit/Component.html" title="class in com.sun.lwuit">Component</A>&nbsp;c)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns either the parent form or the component bellow the embedded container
 above c.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#handleComponentAction(com.sun.lwuit.Component, com.sun.lwuit.events.ActionEvent)">handleComponentAction</A></B>(<A HREF="../../../../com/sun/lwuit/Component.html" title="class in com.sun.lwuit">Component</A>&nbsp;c,
                      <A HREF="../../../../com/sun/lwuit/events/ActionEvent.html" title="class in com.sun.lwuit.events">ActionEvent</A>&nbsp;event)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method is invoked for every component to which an action event listener can be bound
 and delivers the event data for the given component seamlessly.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#isBackCommandEnabled()">isBackCommandEnabled</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Seamlessly inserts a back command to all the forms</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#isKeepResourcesInRam()">isKeepResourcesInRam</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates that the UIBuilder should cache resources in memory and never release them.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#isSameBackDestination(com.sun.lwuit.Container, com.sun.lwuit.Container)">isSameBackDestination</A></B>(<A HREF="../../../../com/sun/lwuit/Container.html" title="class in com.sun.lwuit">Container</A>&nbsp;source,
                      <A HREF="../../../../com/sun/lwuit/Container.html" title="class in com.sun.lwuit">Container</A>&nbsp;destination)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;When navigating from one form/container to another we sometimes might not want the
 back command to return to the previous container/form but rather to the one before
 source.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#onCreateRoot(java.lang.String)">onCreateRoot</A></B>(java.lang.String&nbsp;rootName)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method allows binding logic that should occur before creating the root object
 e.g. a case where a created form needs data fetched for it.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#postAsyncCommand(com.sun.lwuit.Command, com.sun.lwuit.events.ActionEvent)">postAsyncCommand</A></B>(<A HREF="../../../../com/sun/lwuit/Command.html" title="class in com.sun.lwuit">Command</A>&nbsp;cmd,
                 <A HREF="../../../../com/sun/lwuit/events/ActionEvent.html" title="class in com.sun.lwuit.events">ActionEvent</A>&nbsp;sourceEvent)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method is invoked in conjunction with asyncCommandProcess after the 
 command was handled asynchroniously on the separate thread.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#postCreateComponent(com.sun.lwuit.Component)">postCreateComponent</A></B>(<A HREF="../../../../com/sun/lwuit/Component.html" title="class in com.sun.lwuit">Component</A>&nbsp;cmp)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Callback to allow binding custom logic/listeners to a component after its major properties were set
 (notice that not all properties or the full hierarchy will be available at this stage).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#postShow(com.sun.lwuit.Form)">postShow</A></B>(<A HREF="../../../../com/sun/lwuit/Form.html" title="class in com.sun.lwuit">Form</A>&nbsp;f)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method allows binding an action that should occur immediately after showing the given
 form</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#postShowContainer(com.sun.lwuit.Container)">postShowContainer</A></B>(<A HREF="../../../../com/sun/lwuit/Container.html" title="class in com.sun.lwuit">Container</A>&nbsp;c)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method allows binding an action that should occur immediately after showing the given
 container</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#processBackground(com.sun.lwuit.Form)">processBackground</A></B>(<A HREF="../../../../com/sun/lwuit/Form.html" title="class in com.sun.lwuit">Form</A>&nbsp;f)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<b>Warning:</b> this method is invoked on a separate thread.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#processCommand(com.sun.lwuit.events.ActionEvent, com.sun.lwuit.Command)">processCommand</A></B>(<A HREF="../../../../com/sun/lwuit/events/ActionEvent.html" title="class in com.sun.lwuit.events">ActionEvent</A>&nbsp;ev,
               <A HREF="../../../../com/sun/lwuit/Command.html" title="class in com.sun.lwuit">Command</A>&nbsp;cmd)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Invoked to process a given command before naviation or any other internal
 processing occurs.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#registerCustomComponent(java.lang.String, java.lang.Class)">registerCustomComponent</A></B>(java.lang.String&nbsp;name,
                        java.lang.Class&nbsp;cmp)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method  allows the UIBuilder to package a smaller portion of LWUIT into the JAR
 and add support for additional 3rd party components to the GUI builder.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#reloadContainer(com.sun.lwuit.Component)">reloadContainer</A></B>(<A HREF="../../../../com/sun/lwuit/Component.html" title="class in com.sun.lwuit">Component</A>&nbsp;cnt)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Useful tool to refresh the current state of a container shown using show container
 without pushing another instance to the back stack</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#reloadForm()">reloadForm</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Useful tool to refresh the current state of a form shown using show form
 without pushing another instance to the back stack</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#removeCommandListener(com.sun.lwuit.events.ActionListener)">removeCommandListener</A></B>(<A HREF="../../../../com/sun/lwuit/events/ActionListener.html" title="interface in com.sun.lwuit.events">ActionListener</A>&nbsp;l)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes a command listener</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#removeCommandListener(java.lang.String, com.sun.lwuit.events.ActionListener)">removeCommandListener</A></B>(java.lang.String&nbsp;formName,
                      <A HREF="../../../../com/sun/lwuit/events/ActionListener.html" title="interface in com.sun.lwuit.events">ActionListener</A>&nbsp;l)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes a command listener on a specific form</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#removeComponentListener(java.lang.String, java.lang.String, java.lang.Object)">removeComponentListener</A></B>(java.lang.String&nbsp;formName,
                        java.lang.String&nbsp;componentName,
                        java.lang.Object&nbsp;listener)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes a component listener bound to a specific component</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#setBackCommandEnabled(boolean)">setBackCommandEnabled</A></B>(boolean&nbsp;back)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Seamlessly inserts a back command to all the forms</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#setContainerState(com.sun.lwuit.Container, java.util.Hashtable)">setContainerState</A></B>(<A HREF="../../../../com/sun/lwuit/Container.html" title="class in com.sun.lwuit">Container</A>&nbsp;cnt,
                  java.util.Hashtable&nbsp;state)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method is the container navigation equivalent of setFormState() see
 that method for details.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#setFormState(com.sun.lwuit.Form, java.util.Hashtable)">setFormState</A></B>(<A HREF="../../../../com/sun/lwuit/Form.html" title="class in com.sun.lwuit">Form</A>&nbsp;f,
             java.util.Hashtable&nbsp;state)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the state of the current form to which we are returing as part
 of the navigation logic.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#setHomeForm(java.lang.String)">setHomeForm</A></B>(java.lang.String&nbsp;homeForm)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;When reaching the home form the navigation stack is cleared</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#setKeepResourcesInRam(boolean)">setKeepResourcesInRam</A></B>(boolean&nbsp;keepResourcesInRam)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates that the UIBuilder should cache resources in memory and never release them.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#setListModel(com.sun.lwuit.List)">setListModel</A></B>(<A HREF="../../../../com/sun/lwuit/List.html" title="class in com.sun.lwuit">List</A>&nbsp;cmp)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Allows a subclass to set the list model for the given component</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#setResourceFile(com.sun.lwuit.util.Resources)">setResourceFile</A></B>(<A HREF="../../../../com/sun/lwuit/util/Resources.html" title="class in com.sun.lwuit.util">Resources</A>&nbsp;res)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the resource file if keep in rum or no path is defined</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#setResourceFilePath(java.lang.String)">setResourceFilePath</A></B>(java.lang.String&nbsp;resourceFilePath)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Allows the navigation code to avoid storing the resource file and lets the GC
 remove it from memory when its not in use</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../com/sun/lwuit/Container.html" title="class in com.sun.lwuit">Container</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#showContainer(java.lang.String, com.sun.lwuit.Command, com.sun.lwuit.Component)">showContainer</A></B>(java.lang.String&nbsp;resourceName,
              <A HREF="../../../../com/sun/lwuit/Command.html" title="class in com.sun.lwuit">Command</A>&nbsp;sourceCommand,
              <A HREF="../../../../com/sun/lwuit/Component.html" title="class in com.sun.lwuit">Component</A>&nbsp;sourceComponent)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method is equivalent to the internal navigation behavior, it adds
 functionality such as the back command into the given form resource and
 shows it.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../com/sun/lwuit/Form.html" title="class in com.sun.lwuit">Form</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/sun/lwuit/util/UIBuilder.html#showForm(java.lang.String, com.sun.lwuit.Command)">showForm</A></B>(java.lang.String&nbsp;resourceName,
         <A HREF="../../../../com/sun/lwuit/Command.html" title="class in com.sun.lwuit">Command</A>&nbsp;sourceCommand)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method is equivalent to the internal navigation behavior, it adds 
 functionality such as the back command into the given form resource and
 shows it.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ============ FIELD DETAIL =========== -->

<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="FORM_STATE_KEY_NAME"><!-- --></A><H3>
FORM_STATE_KEY_NAME</H3>
<PRE>
public static final java.lang.String <B>FORM_STATE_KEY_NAME</B></PRE>
<DL>
<DD>A key in the form state hashtable used in the back command navigation
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.sun.lwuit.util.UIBuilder.FORM_STATE_KEY_NAME">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="FORM_STATE_KEY_FOCUS"><!-- --></A><H3>
FORM_STATE_KEY_FOCUS</H3>
<PRE>
public static final java.lang.String <B>FORM_STATE_KEY_FOCUS</B></PRE>
<DL>
<DD>A key in the form state hashtable used in the back command navigation
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.sun.lwuit.util.UIBuilder.FORM_STATE_KEY_FOCUS">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="FORM_STATE_KEY_SELECTION"><!-- --></A><H3>
FORM_STATE_KEY_SELECTION</H3>
<PRE>
public static final java.lang.String <B>FORM_STATE_KEY_SELECTION</B></PRE>
<DL>
<DD>A key in the form state hashtable used in the back command navigation
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.sun.lwuit.util.UIBuilder.FORM_STATE_KEY_SELECTION">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="BACK_COMMAND_ID"><!-- --></A><H3>
BACK_COMMAND_ID</H3>
<PRE>
public static final int <B>BACK_COMMAND_ID</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.sun.lwuit.util.UIBuilder.BACK_COMMAND_ID">Constant Field Values</A></DL>
</DL>

<!-- ========= CONSTRUCTOR DETAIL ======== -->

<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="UIBuilder()"><!-- --></A><H3>
UIBuilder</H3>
<PRE>
public <B>UIBuilder</B>()</PRE>
<DL>
</DL>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="setBackCommandEnabled(boolean)"><!-- --></A><H3>
setBackCommandEnabled</H3>
<PRE>
public void <B>setBackCommandEnabled</B>(boolean&nbsp;back)</PRE>
<DL>
<DD>Seamlessly inserts a back command to all the forms
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>back</CODE> - true to automatically add a back command</DL>
</DD>
</DL>
<HR>

<A NAME="isBackCommandEnabled()"><!-- --></A><H3>
isBackCommandEnabled</H3>
<PRE>
public boolean <B>isBackCommandEnabled</B>()</PRE>
<DL>
<DD>Seamlessly inserts a back command to all the forms
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if a back command is automatically added</DL>
</DD>
</DL>
<HR>

<A NAME="registerCustomComponent(java.lang.String, java.lang.Class)"><!-- --></A><H3>
registerCustomComponent</H3>
<PRE>
public static void <B>registerCustomComponent</B>(java.lang.String&nbsp;name,
                                           java.lang.Class&nbsp;cmp)</PRE>
<DL>
<DD>This method  allows the UIBuilder to package a smaller portion of LWUIT into the JAR
 and add support for additional 3rd party components to the GUI builder. Components
 must be registered using their UIID name, by default all the content of com.sun.lwuit is
 registered however subpackages and 3rd party components are not.
 Registeration is essential for obfuscation to work properly!
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the component (UIID)<DD><CODE>cmp</CODE> - the class for the given component</DL>
</DD>
</DL>
<HR>

<A NAME="createContainer(java.lang.String, java.lang.String)"><!-- --></A><H3>
createContainer</H3>
<PRE>
public <A HREF="../../../../com/sun/lwuit/Container.html" title="class in com.sun.lwuit">Container</A> <B>createContainer</B>(java.lang.String&nbsp;resPath,
                                 java.lang.String&nbsp;resourceName)</PRE>
<DL>
<DD>Creates the container defined under the given name in the res file
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>resPath</CODE> - the path to the res file containing the UI widget<DD><CODE>resourceName</CODE> - the name of the widget in the res file
<DT><B>Returns:</B><DD>a LWUIT container instance</DL>
</DD>
</DL>
<HR>

<A NAME="createContainer(com.sun.lwuit.util.Resources, java.lang.String)"><!-- --></A><H3>
createContainer</H3>
<PRE>
public <A HREF="../../../../com/sun/lwuit/Container.html" title="class in com.sun.lwuit">Container</A> <B>createContainer</B>(<A HREF="../../../../com/sun/lwuit/util/Resources.html" title="class in com.sun.lwuit.util">Resources</A>&nbsp;res,
                                 java.lang.String&nbsp;resourceName)</PRE>
<DL>
<DD>Creates the container defined under the given name in the res file
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>res</CODE> - the res file containing the UI widget<DD><CODE>resourceName</CODE> - the name of the widget in the res file
<DT><B>Returns:</B><DD>a LWUIT container instance</DL>
</DD>
</DL>
<HR>

<A NAME="findByName(java.lang.String, com.sun.lwuit.Container)"><!-- --></A><H3>
findByName</H3>
<PRE>
public <A HREF="../../../../com/sun/lwuit/Component.html" title="class in com.sun.lwuit">Component</A> <B>findByName</B>(java.lang.String&nbsp;name,
                            <A HREF="../../../../com/sun/lwuit/Container.html" title="class in com.sun.lwuit">Container</A>&nbsp;rootComponent)</PRE>
<DL>
<DD>Finds the given component by its name
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the component as defined in the resource editor<DD><CODE>rootComponent</CODE> - the root container
<DT><B>Returns:</B><DD>the component matching the given name or null if its not found</DL>
</DD>
</DL>
<HR>

<A NAME="createComponentInstance(java.lang.String, java.lang.Class)"><!-- --></A><H3>
createComponentInstance</H3>
<PRE>
protected <A HREF="../../../../com/sun/lwuit/Component.html" title="class in com.sun.lwuit">Component</A> <B>createComponentInstance</B>(java.lang.String&nbsp;componentType,
                                            java.lang.Class&nbsp;cls)</PRE>
<DL>
<DD>This method can be overriden to create custom components in a custom way, the component
 type is a shorthand for the component name and not the full name of the class.
 By default this method returns null which indicates LWUIT should try to reolve the component
 on its own.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>componentType</CODE> - the type of the component from the UI builder<DD><CODE>cls</CODE> - assumed component class based on the component registry
<DT><B>Returns:</B><DD>a new component instance or null</DL>
</DD>
</DL>
<HR>

<A NAME="postCreateComponent(com.sun.lwuit.Component)"><!-- --></A><H3>
postCreateComponent</H3>
<PRE>
protected void <B>postCreateComponent</B>(<A HREF="../../../../com/sun/lwuit/Component.html" title="class in com.sun.lwuit">Component</A>&nbsp;cmp)</PRE>
<DL>
<DD>Callback to allow binding custom logic/listeners to a component after its major properties were set
 (notice that not all properties or the full hierarchy will be available at this stage). This
 is the perfect place to bind models/renderers etc. to components.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>cmp</CODE> - the component</DL>
</DD>
</DL>
<HR>

<A NAME="bindListenerToComponent(com.sun.lwuit.Component, java.lang.Object)"><!-- --></A><H3>
bindListenerToComponent</H3>
<PRE>
protected void <B>bindListenerToComponent</B>(<A HREF="../../../../com/sun/lwuit/Component.html" title="class in com.sun.lwuit">Component</A>&nbsp;cmp,
                                       java.lang.Object&nbsp;listener)</PRE>
<DL>
<DD>Binds the given listener object to the component, this works seamlessly for 
 common LWUIT events but might be an issue with custom components and custom
 listener types so this method can be overloaded to add support for such cases.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>cmp</CODE> - the component to bind the listener to<DD><CODE>listener</CODE> - the listener object</DL>
</DD>
</DL>
<HR>

<A NAME="setListModel(com.sun.lwuit.List)"><!-- --></A><H3>
setListModel</H3>
<PRE>
protected boolean <B>setListModel</B>(<A HREF="../../../../com/sun/lwuit/List.html" title="class in com.sun.lwuit">List</A>&nbsp;cmp)</PRE>
<DL>
<DD>Allows a subclass to set the list model for the given component
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>cmp</CODE> - the list whose model may be set
<DT><B>Returns:</B><DD>true if a model was set by this method</DL>
</DD>
</DL>
<HR>

<A NAME="createCommand(java.lang.String, com.sun.lwuit.Image, int, java.lang.String)"><!-- --></A><H3>
createCommand</H3>
<PRE>
protected <A HREF="../../../../com/sun/lwuit/Command.html" title="class in com.sun.lwuit">Command</A> <B>createCommand</B>(java.lang.String&nbsp;commandName,
                                <A HREF="../../../../com/sun/lwuit/Image.html" title="class in com.sun.lwuit">Image</A>&nbsp;icon,
                                int&nbsp;commandId,
                                java.lang.String&nbsp;action)</PRE>
<DL>
<DD>Creates a command instance. This method is invoked by the loading code and
 can be overriden to create a subclass of the Command class.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>commandName</CODE> - the label on the command<DD><CODE>icon</CODE> - the icon for the command<DD><CODE>commandId</CODE> - the id of the command<DD><CODE>action</CODE> - the action assigned to the command if such an action is defined
<DT><B>Returns:</B><DD>a new command instance</DL>
</DD>
</DL>
<HR>

<A NAME="fetchResourceFile()"><!-- --></A><H3>
fetchResourceFile</H3>
<PRE>
protected <A HREF="../../../../com/sun/lwuit/util/Resources.html" title="class in com.sun.lwuit.util">Resources</A> <B>fetchResourceFile</B>()</PRE>
<DL>
<DD>This method may be overriden by subclasses to provide a way to dynamically load
 a resource file. Normally the navigation feature of the UIBuilder requires the resource
 file present in RAM. However, that might be expensive to maintain.
 By implementing this method and replacing the storeResourceFile() with an empty
 implementation the resource file storage can be done strictly in RAM.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the instance of the resource file</DL>
</DD>
</DL>
<HR>

<A NAME="getResourceFilePath()"><!-- --></A><H3>
getResourceFilePath</H3>
<PRE>
public java.lang.String <B>getResourceFilePath</B>()</PRE>
<DL>
<DD>Allows the navigation code to avoid storing the resource file and lets the GC
 remove it from memory when its not in use
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the resourceFilePath</DL>
</DD>
</DL>
<HR>

<A NAME="setResourceFilePath(java.lang.String)"><!-- --></A><H3>
setResourceFilePath</H3>
<PRE>
public void <B>setResourceFilePath</B>(java.lang.String&nbsp;resourceFilePath)</PRE>
<DL>
<DD>Allows the navigation code to avoid storing the resource file and lets the GC
 remove it from memory when its not in use
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>resourceFilePath</CODE> - the resourceFilePath to set</DL>
</DD>
</DL>
<HR>

<A NAME="setResourceFile(com.sun.lwuit.util.Resources)"><!-- --></A><H3>
setResourceFile</H3>
<PRE>
protected void <B>setResourceFile</B>(<A HREF="../../../../com/sun/lwuit/util/Resources.html" title="class in com.sun.lwuit.util">Resources</A>&nbsp;res)</PRE>
<DL>
<DD>Sets the resource file if keep in rum or no path is defined
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>res</CODE> - the resource file</DL>
</DD>
</DL>
<HR>

<A NAME="processCommand(com.sun.lwuit.events.ActionEvent, com.sun.lwuit.Command)"><!-- --></A><H3>
processCommand</H3>
<PRE>
protected void <B>processCommand</B>(<A HREF="../../../../com/sun/lwuit/events/ActionEvent.html" title="class in com.sun.lwuit.events">ActionEvent</A>&nbsp;ev,
                              <A HREF="../../../../com/sun/lwuit/Command.html" title="class in com.sun.lwuit">Command</A>&nbsp;cmd)</PRE>
<DL>
<DD>Invoked to process a given command before naviation or any other internal
 processing occurs. The event can be consumed to prevent further processing.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>ev</CODE> - the action event source of the command<DD><CODE>cmd</CODE> - the command to process</DL>
</DD>
</DL>
<HR>

<A NAME="addCommandListener(com.sun.lwuit.events.ActionListener)"><!-- --></A><H3>
addCommandListener</H3>
<PRE>
public void <B>addCommandListener</B>(<A HREF="../../../../com/sun/lwuit/events/ActionListener.html" title="interface in com.sun.lwuit.events">ActionListener</A>&nbsp;l)</PRE>
<DL>
<DD>Adds a command listener that would be bound to all forms in the GUI seamlessly
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>l</CODE> - the listener to bind</DL>
</DD>
</DL>
<HR>

<A NAME="removeCommandListener(com.sun.lwuit.events.ActionListener)"><!-- --></A><H3>
removeCommandListener</H3>
<PRE>
public void <B>removeCommandListener</B>(<A HREF="../../../../com/sun/lwuit/events/ActionListener.html" title="interface in com.sun.lwuit.events">ActionListener</A>&nbsp;l)</PRE>
<DL>
<DD>Removes a command listener
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>l</CODE> - the listener to remove</DL>
</DD>
</DL>
<HR>

<A NAME="addComponentListener(java.lang.String, java.lang.String, java.lang.Object)"><!-- --></A><H3>
addComponentListener</H3>
<PRE>
public void <B>addComponentListener</B>(java.lang.String&nbsp;formName,
                                 java.lang.String&nbsp;componentName,
                                 java.lang.Object&nbsp;listener)</PRE>
<DL>
<DD>Adds a component listener that would be bound when a UI for this form is created.
 Notice that this method is only effective before the form was created and would do
 nothing for an existing form
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>formName</CODE> - the name of the form to which the listener should be bound<DD><CODE>componentName</CODE> - the name of the component to bind to<DD><CODE>listener</CODE> - the listener to bind, common listener types are supported</DL>
</DD>
</DL>
<HR>

<A NAME="removeComponentListener(java.lang.String, java.lang.String, java.lang.Object)"><!-- --></A><H3>
removeComponentListener</H3>
<PRE>
public void <B>removeComponentListener</B>(java.lang.String&nbsp;formName,
                                    java.lang.String&nbsp;componentName,
                                    java.lang.Object&nbsp;listener)</PRE>
<DL>
<DD>Removes a component listener bound to a specific component
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>formName</CODE> - the name of the form<DD><CODE>componentName</CODE> - the name of the component<DD><CODE>listener</CODE> - the listener instance</DL>
</DD>
</DL>
<HR>

<A NAME="addCommandListener(java.lang.String, com.sun.lwuit.events.ActionListener)"><!-- --></A><H3>
addCommandListener</H3>
<PRE>
public void <B>addCommandListener</B>(java.lang.String&nbsp;formName,
                               <A HREF="../../../../com/sun/lwuit/events/ActionListener.html" title="interface in com.sun.lwuit.events">ActionListener</A>&nbsp;l)</PRE>
<DL>
<DD>Adds a command listener to be invoked for commands on a specific form
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>formName</CODE> - the name of the form to which the listener should be bound<DD><CODE>l</CODE> - the listener to bind</DL>
</DD>
</DL>
<HR>

<A NAME="removeCommandListener(java.lang.String, com.sun.lwuit.events.ActionListener)"><!-- --></A><H3>
removeCommandListener</H3>
<PRE>
public void <B>removeCommandListener</B>(java.lang.String&nbsp;formName,
                                  <A HREF="../../../../com/sun/lwuit/events/ActionListener.html" title="interface in com.sun.lwuit.events">ActionListener</A>&nbsp;l)</PRE>
<DL>
<DD>Removes a command listener on a specific form
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>formName</CODE> - the name of the form<DD><CODE>l</CODE> - the listener to remove</DL>
</DD>
</DL>
<HR>

<A NAME="handleComponentAction(com.sun.lwuit.Component, com.sun.lwuit.events.ActionEvent)"><!-- --></A><H3>
handleComponentAction</H3>
<PRE>
protected void <B>handleComponentAction</B>(<A HREF="../../../../com/sun/lwuit/Component.html" title="class in com.sun.lwuit">Component</A>&nbsp;c,
                                     <A HREF="../../../../com/sun/lwuit/events/ActionEvent.html" title="class in com.sun.lwuit.events">ActionEvent</A>&nbsp;event)</PRE>
<DL>
<DD>This method is invoked for every component to which an action event listener can be bound
 and delivers the event data for the given component seamlessly.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>c</CODE> - the component broadcasting the event<DD><CODE>event</CODE> - the event meta data</DL>
</DD>
</DL>
<HR>

<A NAME="asyncCommandProcess(com.sun.lwuit.Command, com.sun.lwuit.events.ActionEvent)"><!-- --></A><H3>
asyncCommandProcess</H3>
<PRE>
protected void <B>asyncCommandProcess</B>(<A HREF="../../../../com/sun/lwuit/Command.html" title="class in com.sun.lwuit">Command</A>&nbsp;cmd,
                                   <A HREF="../../../../com/sun/lwuit/events/ActionEvent.html" title="class in com.sun.lwuit.events">ActionEvent</A>&nbsp;sourceEvent)</PRE>
<DL>
<DD>Warning: This method is invoked OFF the EDT and is intended for usage with asynchronous
 command processing. This method is invoked when the UI indicates that an operation
 should occur in the background. To finish the processing of the operation within the
 EDT one should overide the postAsyncCommand() method.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>cmd</CODE> - the command requiring background processing<DD><CODE>sourceEvent</CODE> - the triggering event</DL>
</DD>
</DL>
<HR>

<A NAME="postAsyncCommand(com.sun.lwuit.Command, com.sun.lwuit.events.ActionEvent)"><!-- --></A><H3>
postAsyncCommand</H3>
<PRE>
protected void <B>postAsyncCommand</B>(<A HREF="../../../../com/sun/lwuit/Command.html" title="class in com.sun.lwuit">Command</A>&nbsp;cmd,
                                <A HREF="../../../../com/sun/lwuit/events/ActionEvent.html" title="class in com.sun.lwuit.events">ActionEvent</A>&nbsp;sourceEvent)</PRE>
<DL>
<DD>This method is invoked in conjunction with asyncCommandProcess after the 
 command was handled asynchroniously on the separate thread. Here LWUIT
 code can be execute to update the UI with the results from the separate thread.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>cmd</CODE> - the command<DD><CODE>sourceEvent</CODE> - the source event</DL>
</DD>
</DL>
<HR>

<A NAME="processBackground(com.sun.lwuit.Form)"><!-- --></A><H3>
processBackground</H3>
<PRE>
protected boolean <B>processBackground</B>(<A HREF="../../../../com/sun/lwuit/Form.html" title="class in com.sun.lwuit">Form</A>&nbsp;f)</PRE>
<DL>
<DD><b>Warning:</b> this method is invoked on a separate thread. 
 This method is invoked when a next form property is defined, this property
 indicates a background process for a form of a transitional nature should
 take place (e.g. splash screen, IO etc.) after which the next form should be shown.
 After this method completes the next form is shown.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>f</CODE> - the form for which the background thread was constructed, notice
 that most methods are not threadsafe and one should use callSerially* in this
 method when mutating the form.
<DT><B>Returns:</B><DD>if false is returned from this method navigation should not proceed
 to that given form</DL>
</DD>
</DL>
<HR>

<A NAME="getFormState(com.sun.lwuit.Form)"><!-- --></A><H3>
getFormState</H3>
<PRE>
protected java.util.Hashtable <B>getFormState</B>(<A HREF="../../../../com/sun/lwuit/Form.html" title="class in com.sun.lwuit">Form</A>&nbsp;f)</PRE>
<DL>
<DD>Returns the state of the current form which we are about to leave as part
 of the navigation logic. When a back command will return to this form the
 state would be restored using setFormState.
 The default implementation of this method restores focus and list selection.
 You can add arbitrary keys to the form state, keys starting with a $ sign
 are reserved for the UIBuilder base class use.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>f</CODE> - the form whose state should be preserved
<DT><B>Returns:</B><DD>arbitrary state object</DL>
</DD>
</DL>
<HR>

<A NAME="setFormState(com.sun.lwuit.Form, java.util.Hashtable)"><!-- --></A><H3>
setFormState</H3>
<PRE>
protected void <B>setFormState</B>(<A HREF="../../../../com/sun/lwuit/Form.html" title="class in com.sun.lwuit">Form</A>&nbsp;f,
                            java.util.Hashtable&nbsp;state)</PRE>
<DL>
<DD>Sets the state of the current form to which we are returing as part
 of the navigation logic. When a back command is pressed this form
 state should be restored, it was obtained via getFormState.
 The default implementation of this method restores focus and list selection.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>f</CODE> - the form whose state should be preserved<DD><CODE>state</CODE> - arbitrary state object</DL>
</DD>
</DL>
<HR>

<A NAME="getContainerState(com.sun.lwuit.Container)"><!-- --></A><H3>
getContainerState</H3>
<PRE>
protected java.util.Hashtable <B>getContainerState</B>(<A HREF="../../../../com/sun/lwuit/Container.html" title="class in com.sun.lwuit">Container</A>&nbsp;cnt)</PRE>
<DL>
<DD>This method is the container navigation equivalent of getFormState() see
 that method for details.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>cnt</CODE> - the container
<DT><B>Returns:</B><DD>the state</DL>
</DD>
</DL>
<HR>

<A NAME="setContainerState(com.sun.lwuit.Container, java.util.Hashtable)"><!-- --></A><H3>
setContainerState</H3>
<PRE>
protected void <B>setContainerState</B>(<A HREF="../../../../com/sun/lwuit/Container.html" title="class in com.sun.lwuit">Container</A>&nbsp;cnt,
                                 java.util.Hashtable&nbsp;state)</PRE>
<DL>
<DD>This method is the container navigation equivalent of setFormState() see
 that method for details.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>cnt</CODE> - the container<DD><CODE>state</CODE> - the state</DL>
</DD>
</DL>
<HR>

<A NAME="getHomeForm()"><!-- --></A><H3>
getHomeForm</H3>
<PRE>
public java.lang.String <B>getHomeForm</B>()</PRE>
<DL>
<DD>When reaching the home form the navigation stack is cleared
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the homeForm</DL>
</DD>
</DL>
<HR>

<A NAME="setHomeForm(java.lang.String)"><!-- --></A><H3>
setHomeForm</H3>
<PRE>
public void <B>setHomeForm</B>(java.lang.String&nbsp;homeForm)</PRE>
<DL>
<DD>When reaching the home form the navigation stack is cleared
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>homeForm</CODE> - the homeForm to set</DL>
</DD>
</DL>
<HR>

<A NAME="back()"><!-- --></A><H3>
back</H3>
<PRE>
public void <B>back</B>()</PRE>
<DL>
<DD>This method effectively pops the form navigation stack and goes back
 to the previous form if back navigation is enabled and there is
 a previous form.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="back(com.sun.lwuit.Component)"><!-- --></A><H3>
back</H3>
<PRE>
public void <B>back</B>(<A HREF="../../../../com/sun/lwuit/Component.html" title="class in com.sun.lwuit">Component</A>&nbsp;sourceComponent)</PRE>
<DL>
<DD>This method effectively pops the form navigation stack and goes back
 to the previous form if back navigation is enabled and there is
 a previous form.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>sourceComponent</CODE> - the component that triggered the back command which effectively
 allows us to find the EmbeddedContainer for a case of container navigation. Null
 can be used if not applicable.</DL>
</DD>
</DL>
<HR>

<A NAME="showContainer(java.lang.String, com.sun.lwuit.Command, com.sun.lwuit.Component)"><!-- --></A><H3>
showContainer</H3>
<PRE>
public <A HREF="../../../../com/sun/lwuit/Container.html" title="class in com.sun.lwuit">Container</A> <B>showContainer</B>(java.lang.String&nbsp;resourceName,
                               <A HREF="../../../../com/sun/lwuit/Command.html" title="class in com.sun.lwuit">Command</A>&nbsp;sourceCommand,
                               <A HREF="../../../../com/sun/lwuit/Component.html" title="class in com.sun.lwuit">Component</A>&nbsp;sourceComponent)</PRE>
<DL>
<DD>This method is equivalent to the internal navigation behavior, it adds
 functionality such as the back command into the given form resource and
 shows it. If the source command is the back command the showBack() method
 will run.
 Notice that container navigation (none-form) doesn't support the back() method
 or the form stack. However a command marked as back command will be respected.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>resourceName</CODE> - the name of the resource for the form to show<DD><CODE>sourceCommand</CODE> - the command of the resource (may be null)<DD><CODE>sourceComponent</CODE> - the component that activated the show (may be null)
<DT><B>Returns:</B><DD>the container thats being shown, notice that you can still manipulate
 some states of the container before it actually appears</DL>
</DD>
</DL>
<HR>

<A NAME="reloadContainer(com.sun.lwuit.Component)"><!-- --></A><H3>
reloadContainer</H3>
<PRE>
public void <B>reloadContainer</B>(<A HREF="../../../../com/sun/lwuit/Component.html" title="class in com.sun.lwuit">Component</A>&nbsp;cnt)</PRE>
<DL>
<DD>Useful tool to refresh the current state of a container shown using show container
 without pushing another instance to the back stack
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>cnt</CODE> - the container thats embedded into the application</DL>
</DD>
</DL>
<HR>

<A NAME="reloadForm()"><!-- --></A><H3>
reloadForm</H3>
<PRE>
public void <B>reloadForm</B>()</PRE>
<DL>
<DD>Useful tool to refresh the current state of a form shown using show form
 without pushing another instance to the back stack
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="allowBackTo(java.lang.String)"><!-- --></A><H3>
allowBackTo</H3>
<PRE>
protected boolean <B>allowBackTo</B>(java.lang.String&nbsp;formName)</PRE>
<DL>
<DD>Indicates whether a back command to this form should be generated automatically when
 leaving said form.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>formName</CODE> - the name of the form
<DT><B>Returns:</B><DD>true to autogenerate and add a back command to the destination form</DL>
</DD>
</DL>
<HR>

<A NAME="isSameBackDestination(com.sun.lwuit.Container, com.sun.lwuit.Container)"><!-- --></A><H3>
isSameBackDestination</H3>
<PRE>
protected boolean <B>isSameBackDestination</B>(<A HREF="../../../../com/sun/lwuit/Container.html" title="class in com.sun.lwuit">Container</A>&nbsp;source,
                                        <A HREF="../../../../com/sun/lwuit/Container.html" title="class in com.sun.lwuit">Container</A>&nbsp;destination)</PRE>
<DL>
<DD>When navigating from one form/container to another we sometimes might not want the
 back command to return to the previous container/form but rather to the one before
 source. A good example would be a "refresh" command or a toggle button that changes
 the form state.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>source</CODE> - the form or container we are leaving<DD><CODE>destination</CODE> - the container or form we are navigating to
<DT><B>Returns:</B><DD>false if we want a standard back button to source, true if we want to use
 the same back button as the one in source</DL>
</DD>
</DL>
<HR>

<A NAME="showForm(java.lang.String, com.sun.lwuit.Command)"><!-- --></A><H3>
showForm</H3>
<PRE>
public <A HREF="../../../../com/sun/lwuit/Form.html" title="class in com.sun.lwuit">Form</A> <B>showForm</B>(java.lang.String&nbsp;resourceName,
                     <A HREF="../../../../com/sun/lwuit/Command.html" title="class in com.sun.lwuit">Command</A>&nbsp;sourceCommand)</PRE>
<DL>
<DD>This method is equivalent to the internal navigation behavior, it adds 
 functionality such as the back command into the given form resource and
 shows it. If the source command is the back command the showBack() method
 will run.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>resourceName</CODE> - the name of the resource for the form to show<DD><CODE>sourceCommand</CODE> - the command of the resource (may be null)
<DT><B>Returns:</B><DD>the form thats being shown, notice that you can still manipulate
 some states of the form before it actually appears</DL>
</DD>
</DL>
<HR>

<A NAME="exitForm(com.sun.lwuit.Form)"><!-- --></A><H3>
exitForm</H3>
<PRE>
protected void <B>exitForm</B>(<A HREF="../../../../com/sun/lwuit/Form.html" title="class in com.sun.lwuit">Form</A>&nbsp;f)</PRE>
<DL>
<DD>This method allows binding an action that should occur before leaving the given
 form, e.g. memory cleanup
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>f</CODE> - the form being left</DL>
</DD>
</DL>
<HR>

<A NAME="beforeShow(com.sun.lwuit.Form)"><!-- --></A><H3>
beforeShow</H3>
<PRE>
protected void <B>beforeShow</B>(<A HREF="../../../../com/sun/lwuit/Form.html" title="class in com.sun.lwuit">Form</A>&nbsp;f)</PRE>
<DL>
<DD>This method allows binding an action that should occur before showing the given
 form
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>f</CODE> - the form about to be shown</DL>
</DD>
</DL>
<HR>

<A NAME="postShow(com.sun.lwuit.Form)"><!-- --></A><H3>
postShow</H3>
<PRE>
protected void <B>postShow</B>(<A HREF="../../../../com/sun/lwuit/Form.html" title="class in com.sun.lwuit">Form</A>&nbsp;f)</PRE>
<DL>
<DD>This method allows binding an action that should occur immediately after showing the given
 form
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>f</CODE> - the form that was just shown</DL>
</DD>
</DL>
<HR>

<A NAME="beforeShowContainer(com.sun.lwuit.Container)"><!-- --></A><H3>
beforeShowContainer</H3>
<PRE>
protected void <B>beforeShowContainer</B>(<A HREF="../../../../com/sun/lwuit/Container.html" title="class in com.sun.lwuit">Container</A>&nbsp;c)</PRE>
<DL>
<DD>This method allows binding an action that should occur before showing the given
 container
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>c</CODE> - the container about to be shown</DL>
</DD>
</DL>
<HR>

<A NAME="postShowContainer(com.sun.lwuit.Container)"><!-- --></A><H3>
postShowContainer</H3>
<PRE>
protected void <B>postShowContainer</B>(<A HREF="../../../../com/sun/lwuit/Container.html" title="class in com.sun.lwuit">Container</A>&nbsp;c)</PRE>
<DL>
<DD>This method allows binding an action that should occur immediately after showing the given
 container
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>c</CODE> - the container that was just shown</DL>
</DD>
</DL>
<HR>

<A NAME="onCreateRoot(java.lang.String)"><!-- --></A><H3>
onCreateRoot</H3>
<PRE>
protected void <B>onCreateRoot</B>(java.lang.String&nbsp;rootName)</PRE>
<DL>
<DD>This method allows binding logic that should occur before creating the root object
 e.g. a case where a created form needs data fetched for it.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>rootName</CODE> - the name of the root to be created from the resource file</DL>
</DD>
</DL>
<HR>

<A NAME="isKeepResourcesInRam()"><!-- --></A><H3>
isKeepResourcesInRam</H3>
<PRE>
public boolean <B>isKeepResourcesInRam</B>()</PRE>
<DL>
<DD>Indicates that the UIBuilder should cache resources in memory and never release them.
 This is useful with small resource files or high RAM devices since it saves the cost
 of constantly fetching the res file from the jar whenever moving between forms.
 This can be toggled in the properties (e.g. jad) using the flag: cacheResFile (true/false)
 which defaults to false.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the keepResourcesInRam</DL>
</DD>
</DL>
<HR>

<A NAME="setKeepResourcesInRam(boolean)"><!-- --></A><H3>
setKeepResourcesInRam</H3>
<PRE>
public void <B>setKeepResourcesInRam</B>(boolean&nbsp;keepResourcesInRam)</PRE>
<DL>
<DD>Indicates that the UIBuilder should cache resources in memory and never release them.
 This is useful with small resource files or high RAM devices since it saves the cost
 of constantly fetching the res file from the jar whenever moving between forms.
 This can be toggled in the properties (e.g. jad) using the flag: cacheResFile (true/false)
 which defaults to false.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>keepResourcesInRam</CODE> - the keepResourcesInRam to set</DL>
</DD>
</DL>
<HR>

<A NAME="getRootAncestor(com.sun.lwuit.Component)"><!-- --></A><H3>
getRootAncestor</H3>
<PRE>
protected <A HREF="../../../../com/sun/lwuit/Container.html" title="class in com.sun.lwuit">Container</A> <B>getRootAncestor</B>(<A HREF="../../../../com/sun/lwuit/Component.html" title="class in com.sun.lwuit">Component</A>&nbsp;c)</PRE>
<DL>
<DD>Returns either the parent form or the component bellow the embedded container
 above c.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>c</CODE> - the component whose root ancestor we should find
<DT><B>Returns:</B><DD>the root</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>


<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/UIBuilder.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../com/sun/lwuit/util/Resources.html" title="class in com.sun.lwuit.util"><B>PREV CLASS</B></A>&nbsp;
&nbsp;NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html?com/sun/lwuit/util/UIBuilder.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="UIBuilder.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>

</BODY>
</HTML>
